dg::file::Probes< NcFile, Topology > Struct Template Reference

Facilitate output at selected points. More...

Public Member Functions
	Probes ()=default
	Probes (NcFile &file, const Topology &grid, const ProbesParams &params)
	Construct from parameter struct.
template<class ListClass , class ... Params>
void	static_write (const ListClass &records, Params &&... ps)
	Directly write results of a list of callback functions to file.
template<class ListClass , class ... Params>
void	buffer (double time, const ListClass &probe_list, Params &&... ps)
	Write (time-dependent) results of a list of callback functions to internal buffer.
void	flush ()
	Flush the buffer to file.
template<class ListClass , class ... Params>
void	write (double time, const ListClass &probe_list, Params &&... ps)
	Same as buffer followed by flush.

Detailed Description

template<class NcFile, class Topology>
struct dg::file::Probes< NcFile, Topology >

Facilitate output at selected points.

This class is a high level synthetic diagnostics package. Typically, it works together with the dg::file::parse_probes function

Instead of writing to file every time one desires probe outputs, an internal buffer stores the probe values when the buffer member is called. File writes happen only when calling flush

Note

in an MPI program all processes in the file.communicator() have to create the class and call its methods.

It is the topology of the simulation grid that is needed here, i.e. the Topology from which to interpolate, not the topology of the 1d probe array. The class automatically constructs the latter itself.

Attention

Because the paraview NetCDF reader is faulty, it is recommended that Probes is constructed only after all other root dimensions in the file are defined. This is because of the dimension numbering in NetCDF-4.

Constructor & Destructor Documentation

Probes() [1/2]

template<class NcFile , class Topology >

dg::file::Probes< NcFile, Topology >::Probes ( )

default

Probes() [2/2]

template<class NcFile , class Topology >

dg::file::Probes< NcFile, Topology >::Probes ( NcFile & file, const Topology & grid, const ProbesParams & params )

inline

Construct from parameter struct.

Parameters

file	NetCDF file; a "probes" group will be generated in the current group that contains all fields this class writes to file (probe dimensions are called "ptime" and "pdim"). The file must be open.
grid	The interpolation matrix is generated with the grid and params.coords . grid.ndim must equal param.coords.size()
params	Typically read in from file with dg::file::parse_probes

Here is the call graph for this function:

Member Function Documentation

buffer()

template<class NcFile , class Topology >

template<class ListClass , class ... Params>

void dg::file::Probes< NcFile, Topology >::buffer ( double time, const ListClass & probe_list, Params &&... ps )

inline

Write (time-dependent) results of a list of callback functions to internal buffer.

Parameters

time	The time value to store
probe_list	the list of records to store (variables are defined in file on first write)
ps	The parameters forwarded to the record.function( resultD, ps...) The function is supposed to store its result into the given device vector

Note

No data is written to file and the netcdf file does not need to be open.

If param.probes was false in the constructor this function returns immediately

Template Parameters

ListClass

A Type whose ListClass::value_type equals a Record class (e.g. dg::file::Record) The Signature ListClass::value_type::Signature must have either void as return type or a primitive type. The latter indicates a scalar output and must coincide with Topology::ndim() == 0. If the return type is void then the first argument type must be a Vector type constructible from Topology::host_vector e.g. a dg::DVec.

flush()

template<class NcFile , class Topology >

void dg::file::Probes< NcFile, Topology >::flush ( )

inline

Flush the buffer to file.

Write all contents of the buffer to the netcdf file and reset the buffer.

Note

If param.probes was false in the constructor this function returns immediately

Attention

the netcdf file needs to be open when calling this function

static_write()

template<class NcFile , class Topology >

template<class ListClass , class ... Params>

void dg::file::Probes< NcFile, Topology >::static_write ( const ListClass & records, Params &&... ps )

inline

Directly write results of a list of callback functions to file.

Each item in the list consists of a name, attributes and a callback function that is called with result as first argument and the given list of Params as additional arguments.

for ( auto& record : records)
{
    record.name;
    record.atts;
    record.function( result, ps...);
}

The host vector has the size of the grid given in the constructor of the Probes class. The callback function is supposed to write its result into the given host vector.

The result is then interpolated to the probe positions and stored in the netcdf file in the probes group under the given variable name, with the long name as attribute ("long_name") and the "dim" probes dimension.

Note

The netcdf file must be open when this method is called.

If param.probes was false in the constructor this function returns immediately

Template Parameters

ListClass

A Type whose ListClass::value_type equals a Record class (e.g. dg::file::Record) The Signature ListClass::value_type::Signature must have either void as return type or a primitive type. The latter indicates a scalar output and must coincide with Topology::ndim() == 0. If the return type is void then the first argument type must be a Vector type constructible from Topology::host_vector e.g. a dg::DVec.

write()

template<class NcFile , class Topology >

template<class ListClass , class ... Params>

void dg::file::Probes< NcFile, Topology >::write ( double time, const ListClass & probe_list, Params &&... ps )

inline

Same as buffer followed by flush.

buffer( time, probe_list, std::forward<Params>(ps)...);
flush();

---

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

• probes.h