io::ProjectionWriter Class Reference

A callable object that writes projection data. More...

#include <ProjectionWriter.h>

Public Member Functions
void	operator() (Grid3D &G, Parameters P, int nfile, const FnameTemplate &fname_template) const

Detailed Description

A callable object that writes projection data.

Specifically, the object writes xy and xz cell-cenetered projections of the grid data.

For more context, a "callable" object is sometimes called a "functor." Essentially a "callable" object carries around state and can be called like a function.

Note

At the time of writing, this doesn't get configured at startup and doesn't need to a full-blown class. Right now, this mostly exists for consistency with other output approaches.

Member Function Documentation

operator()()

void io::ProjectionWriter::operator()	(	Grid3D &	G,
		Parameters	P,
		int	nfile,
		const FnameTemplate &	fname_template
	)		const

Implements the a callable method that writes projection data

Note

For less experienced C++ developers: this overloads the "function call operator". If we have an instance, obj, then you call this method by invoking obj(G, P, nfile, fname_template).

---

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

• ProjectionWriter.h
• ProjectionWriter.cpp