ViennaSHE 1.3.0
Free open-source semiconductor device simulator using spherical harmonics expansions techniques.
viennashe::io::gnuplot_edf_writer Struct Reference

Writes the energy distribution function to a file which can be processed by Gnuplot. Works for 1d, 2d and 3d only. More...

#include <gnuplot_writer_edf.hpp>

Public Member Functions

template<typename DeviceType , typename EDFWrapperT >
void operator() (DeviceType const &device, EDFWrapperT const &edf, const double coordinate_x, const std::string filename) const
 Triggers the write process. More...
 
template<typename DeviceType , typename CellFilterType , typename EDFWrapperT >
void operator() (DeviceType const &device, CellFilterType const &cell_filter, EDFWrapperT const &edf, const std::string filename)
 Helper function for writing the energy distribution function at a particular points to a plain text file. Output can be processed by e.g. Gnuplot. More...
 

Detailed Description

Writes the energy distribution function to a file which can be processed by Gnuplot. Works for 1d, 2d and 3d only.

Definition at line 44 of file gnuplot_writer_edf.hpp.

Member Function Documentation

◆ operator()() [1/2]

template<typename DeviceType , typename CellFilterType , typename EDFWrapperT >
void viennashe::io::gnuplot_edf_writer::operator() ( DeviceType const &  device,
CellFilterType const &  cell_filter,
EDFWrapperT const &  edf,
const std::string  filename 
)
inline

Helper function for writing the energy distribution function at a particular points to a plain text file. Output can be processed by e.g. Gnuplot.

Parameters
deviceThe device
cell_filterA cell filter (has operator(CellType const & cell)), which returns true if the writer should be doing something for the given cell
edfThe energy distribution function (cf. df_wrappers.hpp)
filenameThe path/filename where the data gets written to

Definition at line 120 of file gnuplot_writer_edf.hpp.

◆ operator()() [2/2]

template<typename DeviceType , typename EDFWrapperT >
void viennashe::io::gnuplot_edf_writer::operator() ( DeviceType const &  device,
EDFWrapperT const &  edf,
const double  coordinate_x,
const std::string  filename 
) const
inline

Triggers the write process.

Parameters
deviceThe device (includes a ViennaGrid mesh) on which simulation is carried out
edfThe distribution function
coordinate_xx-coordinate of the point for which the data should be written
filenameName of the file to be written to

Definition at line 55 of file gnuplot_writer_edf.hpp.


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