WaveSimPP 1.0
A C library for solving the wave equation and reconstructing the wave field
All Classes Namespaces Functions Modules Pages
Public Member Functions | List of all members
wavePlotter::Plotter Class Reference

This class is used to plot the wave field TODO: make it multithreaded. More...

#include <wavePlotter.hpp>

Public Member Functions

 Plotter (const boost::multi_array< double, 3 > &u, const matplot::vector_2d &Xp, const matplot::vector_2d &Zp, int num_levels, int nt)
 Constructor.
 
void renderFrame (int index)
 Renders a frame of the wave field to a image on disk.
 
void renderAllFrames (int begin_frame_index, int end_frame_index)
 Renders all frames of the wave field to form an animation to be saved on disk.
 
void animate (std::string output_file_name, int begin_frame_index, int end_frame_index, int frame_rate)
 Renders a complete video animation of the wave field.
 
void exportFrame (int index)
 Export a frame of the wave field to a .csv format for external use.
 
void exportAllFrames (int begin_frame_index, int end_frame_index)
 Export all frames of the wave field to a .csv format for external use.
 
void setSaveDirectory (std::string save_directory)
 Set the save directory for the rendered frames.
 

Detailed Description

This class is used to plot the wave field TODO: make it multithreaded.

Plotter class

Definition at line 21 of file wavePlotter.hpp.


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