From 2d144e21acebccb563db72d3e6021fbc38b53d86 Mon Sep 17 00:00:00 2001 From: Patrick Shriwise Date: Sun, 17 Mar 2019 19:36:34 -0500 Subject: [PATCH] Updating/adding some docstrings. --- include/openmc/plot.h | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/include/openmc/plot.h b/include/openmc/plot.h index 28e6734eb..08797c33b 100644 --- a/include/openmc/plot.h +++ b/include/openmc/plot.h @@ -51,10 +51,10 @@ struct RGBColor { uint8_t red, green, blue; }; - typedef xt::xtensor ImageData; -struct IdData { +struct IdData +{ // Constructor IdData(int h_res, int v_res); @@ -62,10 +62,11 @@ struct IdData { void set_value(int y, int x, const Particle& p, int level); // Members - xt::xtensor data_; + xt::xtensor data_; //!< 2D array of cell & material ids }; -struct PropertyData { +struct PropertyData +{ // Constructor PropertyData(int h_res, int v_res); @@ -73,7 +74,7 @@ struct PropertyData { void set_value(int y, int x, const Particle& p, int level); // Members - xt::xtensor data_; + xt::xtensor data_; //!< 2D array of temperature & density data }; enum class PlotType { @@ -95,7 +96,9 @@ enum class PlotColorBy { //=============================================================================== // Plot class //=============================================================================== -class PlotBase { +class PlotBase +{ + // Methods public: IdData get_id_map() const; PropertyData get_property_map() const;