Add clean data functionality

Author: jchristopherson

src/fplot_filled_plot_data.f90

@@ -24,6 +24,7 @@ module fplot_filled_plot_data
         procedure, public :: get_command_string => fpd_get_cmd
         procedure, public :: get_data_string => fpd_get_data_cmd
         procedure, public :: define_data => fpd_define_data
+        procedure, public :: clean_data => fpd_clean_data
     end type
 
 contains
@@ -209,5 +210,13 @@ subroutine fpd_define_data(this, x, y, yc, err)
         end do
     end subroutine
 
+! ------------------------------------------------------------------------------
+    subroutine fpd_clean_data(this)
+        !! Cleans the data from this data set.
+        class(filled_plot_data), intent(inout) :: this
+            !! The filled_plot_data object.
+        if (allocated(this%m_data)) deallocate(this%m_data)
+    end subroutine
+
 ! ------------------------------------------------------------------------------
 end module

src/fplot_plot_data.f90

@@ -34,7 +34,9 @@ module fplot_plot_data
         procedure, public :: set_datablock_name => pd_set_datablock_name
         procedure, public :: create_unique_datablock_name => &
             pd_create_unique_datablock_name
+        procedure, public :: clean => pd_clean
         procedure(pd_get_string_result), deferred, public :: get_data_string
+        procedure(pd_clean_action), deferred, public :: clean_data
     end type
 
     interface
@@ -46,6 +48,13 @@ function pd_get_string_result(this) result(x)
             character(len = :), allocatable :: x
                 !! The string.
         end function
+
+        subroutine pd_clean_action(this)
+            !! Performs a cleaning operation.
+            import plot_data
+            class(plot_data), intent(inout) :: this
+                !! The plot_data object.
+        end subroutine
     end interface
 
     type, abstract, extends(plot_data) :: plot_data_colored
@@ -241,13 +250,27 @@ subroutine pd_create_unique_datablock_name(this)
         real(real64) :: r, rng
         integer(int32) :: count
 
+        call random_seed()
         call random_number(r)
         r = r * huge(count)
         count = floor(r)
         str = "PlotData" // to_string(count)
         call this%set_datablock_name(char(str))
     end subroutine
 
+! ------------------------------------------------------------------------------
+    subroutine pd_clean(this)
+        !! Cleans the data set by removing stored data and clearing the 
+        !! GNUPLOT datablock name.  This routine also calls clean_data to
+        !! ensure the data is cleared from the data set as well as the datablock
+        !! name.
+        class(plot_data), intent(inout) :: this
+            !! The plot_data object.
+
+        call this%set_datablock_name("")
+        call this%clean_data()
+    end subroutine
+
 ! ******************************************************************************
 ! PLOT_DATA_COLORED
 ! ------------------------------------------------------------------------------

src/fplot_plot_data_2d.f90

@@ -33,6 +33,7 @@ module fplot_plot_data_2d
         procedure, public :: get_y_data => pd2d_get_y_array
         procedure, public :: get_color_data => pd2d_get_c_array
         procedure, public :: get_point_size_data => pd2d_get_ps_array
+        procedure, public :: clean_data => pd2d_clean_data
     end type
 
 contains
@@ -443,8 +444,6 @@ function pd2d_get_c_array(this) result(x)
     end if
 end function
 
-! ******************************************************************************
-! ADDED: JAN. 12, 2024 - JAC
 ! ------------------------------------------------------------------------------
 function pd2d_get_ps_array(this) result(x)
     !! Gets the stored point size data array.
@@ -461,5 +460,13 @@ function pd2d_get_ps_array(this) result(x)
     end if
 end function
 
+! ------------------------------------------------------------------------------
+subroutine pd2d_clean_data(this)
+    !! Cleans the data from this data set.
+    class(plot_data_2d), intent(inout) :: this
+        !! The plot_data_2d object.
+    if (allocated(this%m_data)) deallocate(this%m_data)
+end subroutine
+
 ! ------------------------------------------------------------------------------
 end module

src/fplot_plot_data_3d.f90

@@ -29,6 +29,7 @@ module fplot_plot_data_3d
         procedure, public :: get_z_data => pd3d_get_z_array
         procedure, public :: get_color_data => pd3d_get_c_array
         procedure, public :: get_point_size_data => pd3d_get_c_array
+        procedure, public :: clean_data => pd3d_clean_data
     end type
 
 contains
@@ -420,8 +421,6 @@ function pd3d_get_c_array(this) result(x)
     end if
 end function
 
-! ******************************************************************************
-! ADDED: JAN. 12, 2020 - JAC
 ! ------------------------------------------------------------------------------
 function pd3d_get_ps_array(this) result(x)
     !! Gets the stored point scaling data array.
@@ -438,5 +437,13 @@ function pd3d_get_ps_array(this) result(x)
     end if
 end function
 
+! ------------------------------------------------------------------------------
+subroutine pd3d_clean_data(this)
+    !! Cleans the data from this data set.
+    class(plot_data_3d), intent(inout) :: this
+        !! The plot_data_3d object.
+    if (allocated(this%m_data)) deallocate(this%m_data)
+end subroutine
+
 ! ------------------------------------------------------------------------------
 end module

src/fplot_plot_data_bar.f90

@@ -55,6 +55,7 @@ module fplot_plot_data_bar
         procedure, public :: set_data_1 => pdb_set_data_1_core
         procedure, public :: set_data_2 => pdb_set_data_2_core
         procedure, public :: set_data_3 => pdb_set_data_3_core
+        procedure, public :: clean_data => pdb_clean_data
     end type
 
 contains
@@ -583,5 +584,14 @@ subroutine pdb_set_data_3_core(this, labels, x, fmt, err)
     this%m_axisLabels = lbls
 end subroutine
 
+! ------------------------------------------------------------------------------
+subroutine pdb_clean_data(this)
+    !! Cleans the data from this data set.
+    class(plot_data_bar), intent(inout) :: this
+        !! The plot_data_bar object.
+    if (allocated(this%m_axisLabels)) deallocate(this%m_axisLabels)
+    if (allocated(this%m_barData)) deallocate(this%m_barData)
+end subroutine
+
 ! ------------------------------------------------------------------------------
 end module

src/fplot_plot_data_box_whisker.f90

@@ -55,6 +55,7 @@ module fplot_plot_data_box_whisker
         procedure, public :: set_fill_boxes => pdbw_set_fill_boxes
         procedure, public :: get_box_fill_opacity => pdbw_get_opacity
         procedure, public :: set_box_fill_opacity => pdbw_set_opacity
+        procedure, public :: clean_data => pdbw_clean_data
     end type
 
 contains
@@ -379,5 +380,17 @@ subroutine pdbw_set_opacity(this, x)
     this%m_boxOpacity = x
 end subroutine
 
+! ------------------------------------------------------------------------------
+subroutine pdbw_clean_data(this)
+    !! Cleans the data from this data set.
+    class(plot_data_box_whisker), intent(inout) :: this
+        !! The plot_data_box_whisker object.
+    if (allocated(this%m_x)) deallocate(this%m_x)
+    if (allocated(this%m_boxMin)) deallocate(this%m_boxMin)
+    if (allocated(this%m_boxMax)) deallocate(this%m_boxMax)
+    if (allocated(this%m_whiskerMin)) deallocate(this%m_whiskerMin)
+    if (allocated(this%m_whiskerMin)) deallocate(this%m_whiskerMin)
+end subroutine
+
 ! ------------------------------------------------------------------------------
 end module

src/fplot_plot_data_error_bars.f90

@@ -41,7 +41,7 @@ module fplot_plot_data_error_bars
         procedure, public :: get_use_error_box => pde_get_box
         procedure, public :: set_use_error_box => pde_set_box
         procedure, public :: get_use_range => pde_get_use_range
-
+        procedure, public :: clean_data => pde_clean_data
         procedure :: pde_define_x_err
         procedure :: pde_define_y_err
         procedure :: pde_define_xy_err
@@ -715,5 +715,13 @@ subroutine pde_define_xy_err_lim(this, x, y, xmin, xmax, ymin, &
         this%m_range = .true.
     end subroutine
 
+! ------------------------------------------------------------------------------
+    subroutine pde_clean_data(this)
+        !! Cleans the data from this data set.
+        class(plot_data_error_bars), intent(inout) :: this
+            !! The plot_data_error_bars object.
+        if (allocated(this%m_data)) deallocate(this%m_data)
+    end subroutine
+
 ! ------------------------------------------------------------------------------
 end module

src/fplot_plot_data_histogram.f90

@@ -40,6 +40,7 @@ module fplot_plot_data_histogram
         procedure, public :: get_draw_against_y2 => pdh_get_use_y2
         procedure, public :: set_draw_against_y2 => pdh_set_use_y2
         procedure, public :: get => pdh_get_bin_data
+        procedure, public :: clean_data => pdh_clean_data
     end type
 
 contains
@@ -307,5 +308,13 @@ subroutine pdh_get_bin_data(this, i, x, cnt)
     cnt = floor(this%m_data(i,1))
 end subroutine
 
+! ------------------------------------------------------------------------------
+subroutine pdh_clean_data(this)
+    !! Cleans the data from this data set.
+    class(plot_data_histogram), intent(inout) :: this
+        !! The plot_data_histogram object.
+    if (allocated(this%m_data)) deallocate(this%m_data)
+end subroutine
+
 ! ------------------------------------------------------------------------------
 end module

src/fplot_plot_data_tri_2d.f90

@@ -32,6 +32,7 @@ module fplot_plot_data_tri_2d
         procedure, public :: set_line_width => pdt2d_set_line_width
         procedure, public :: get_line_style => pdt2d_get_line_style
         procedure, public :: set_line_style => pdt2d_set_line_style
+        procedure, public :: clean_data => pdt2d_clean_data
     end type
 
 contains
@@ -279,5 +280,15 @@ subroutine pdt2d_set_line_style(this, x)
         end if
     end subroutine
 
+! ------------------------------------------------------------------------------
+    subroutine pdt2d_clean_data(this)
+        !! Cleans the data from this data set.
+        class(plot_data_tri_2d), intent(inout) :: this
+            !! The plot_data_tri_2d object.
+        if (allocated(this%m_indices)) deallocate(this%m_indices)
+        if (allocated(this%m_x)) deallocate(this%m_x)
+        if (allocated(this%m_y)) deallocate(this%m_y)
+    end subroutine
+
 ! ------------------------------------------------------------------------------
 end module

src/fplot_surface_plot_data.f90

@@ -32,6 +32,7 @@ module fplot_surface_plot_data
         procedure, public :: get_command_string => surfd_get_cmd
         procedure, public :: get_data_string => surfd_get_data_cmd
         procedure, public :: define_data => surfd_set_data_1
+        procedure, public :: clean_data => surfd_clean_data
     end type
 
 contains
@@ -319,5 +320,15 @@ subroutine surfd_set_data_1(this, x, y, z, err)
     end do
 end subroutine
 
+! ------------------------------------------------------------------------------
+subroutine surfd_clean_data(this)
+    !! Cleans the data from this data set.
+    class(surface_plot_data), intent(inout) :: this
+        !! The surface_plot_data object.
+    if (allocated(this%m_x)) deallocate(this%m_x)
+    if (allocated(this%m_y)) deallocate(this%m_y)
+    if (allocated(this%m_z)) deallocate(this%m_z)
+end subroutine
+
 ! ------------------------------------------------------------------------------
 end module