walberla::field::AccuracyEvaluationLinePlotter< AccuracyEvaluationLinePlot_T > Class Template Reference

Detailed Description

template<typename AccuracyEvaluationLinePlot_T>
class walberla::field::AccuracyEvaluationLinePlotter< AccuracyEvaluationLinePlot_T >

Class for plotting simulation (and solution) values along a line through the domain.

Accuracy Evaluation Line Plotter

Class for generating a series of plots. Build upon AccuracyEvaluationLinePlot, see Accuracy Evaluation Line Plot !

Do not create objects of class AccuracyEvaluationLinePlotter directly, better use one of the 'makeAccuracyEvaluationLinePlotter' functions below!

Parameters for setting up and controlling the line plotter:

There also exist 'makeAccuracyEvaluationLinePlotter' functions that take configuration file data as an additional parameter in order to parse the configuration file for setting up and controlling the line plotter. The configuration file block looks like as follows:

{
frequency [unsigned integer]; // the plot frequency
filename [string]; // filename base
extension [string]; // file extension
}

Example:

{
frequency 100;
filename AccuracyPlot;
extension txt;
}

Note that the shared pointer returned by all 'makeAccuracyEvaluationLinePlotter' functions can be captured by a SharedFunctor for immediate registration at a time loop (see field::makeSharedFunctor).

#include <AccuracyEvaluationLinePlot.h>

Public Member Functions

 AccuracyEvaluationLinePlotter (const shared_ptr< AccuracyEvaluationLinePlot_T > &plot, const uint_t evaluationFrequency, const std::string &filename=internal::accuracyEvaluationLinePlotterFilename, const std::string &fileExtension=internal::accuracyEvaluationLinePlotterExtension)
 
void operator() ()
 

Private Attributes

shared_ptr< AccuracyEvaluationLinePlot_T > plot_
 
uint_t executionCounter_
 
uint_t evaluationFrequency_
 
std::string filename_
 
std::string fileExtension_
 

Constructor & Destructor Documentation

template<typename AccuracyEvaluationLinePlot_T >
walberla::field::AccuracyEvaluationLinePlotter< AccuracyEvaluationLinePlot_T >::AccuracyEvaluationLinePlotter ( const shared_ptr< AccuracyEvaluationLinePlot_T > &  plot,
const uint_t  evaluationFrequency,
const std::string &  filename = internal::accuracyEvaluationLinePlotterFilename,
const std::string &  fileExtension = internal::accuracyEvaluationLinePlotterExtension 
)
inline

Member Function Documentation

template<typename AccuracyEvaluationLinePlot_T >
void walberla::field::AccuracyEvaluationLinePlotter< AccuracyEvaluationLinePlot_T >::operator() ( )
inline

Member Data Documentation

template<typename AccuracyEvaluationLinePlot_T >
uint_t walberla::field::AccuracyEvaluationLinePlotter< AccuracyEvaluationLinePlot_T >::evaluationFrequency_
private
template<typename AccuracyEvaluationLinePlot_T >
uint_t walberla::field::AccuracyEvaluationLinePlotter< AccuracyEvaluationLinePlot_T >::executionCounter_
private
template<typename AccuracyEvaluationLinePlot_T >
std::string walberla::field::AccuracyEvaluationLinePlotter< AccuracyEvaluationLinePlot_T >::fileExtension_
private
template<typename AccuracyEvaluationLinePlot_T >
std::string walberla::field::AccuracyEvaluationLinePlotter< AccuracyEvaluationLinePlot_T >::filename_
private
template<typename AccuracyEvaluationLinePlot_T >
shared_ptr< AccuracyEvaluationLinePlot_T > walberla::field::AccuracyEvaluationLinePlotter< AccuracyEvaluationLinePlot_T >::plot_
private

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