Provides a three-dimensional surface plot data set. More...

Inheritance diagram for fplot_core::surface_plot_data:

Public Member Functions
procedure, public	get_size surfd_get_size
	Gets the size of the stored data set.

procedure, public	get_x surfd_get_x
	Gets the requested X data point.

procedure, public	set_x surfd_set_x
	Sets the requested X data point.

procedure, public	get_y surfd_get_y
	Gets the requested Y data point.

procedure, public	set_y surfd_set_y
	Sets the requested Y data point.

procedure, public	get_z surfd_get_z
	Gets the requested Z data point.

procedure, public	set_z surfd_set_z
	Sets the requested Z data point.

procedure, public	get_use_wireframe surfd_get_wireframe
	Gets a value determining if a wireframe mesh should be displayed.

procedure, public	set_use_wireframe surfd_set_wireframe
	Sets a value determining if a wireframe mesh should be displayed.

procedure, public	get_command_string surfd_get_cmd
	Gets the GNUPLOT command string to represent this surface_plot_data object.

procedure, public	get_data_string surfd_get_data_cmd
	Gets the GNUPLOT command string containing the actual data to plot.

procedure, public	define_data surfd_set_data_1
	Defines the data set.

Public Member Functions inherited from fplot_core::plot_data
procedure, public	get_name pd_get_name
	Gets the name to associate with this data set.

procedure, public	set_name pd_set_name
	Sets the name to associate with this data set.

Public Attributes
real(real64), dimension(:,:), allocatable	m_y
	Stores the y-coordinate data.

real(real64), dimension(:,:), allocatable	m_z
	Stores the z-coordinate data.

logical	m_wireframe = .false.
	Set to true to display a wireframe of the surface; else, just a smooth surface will be drawn.

Private Attributes
real(real64), dimension(:,:), allocatable	m_x
	Stores the x-coordinate data.

Detailed Description

Provides a three-dimensional surface plot data set.

Definition at line 4599 of file fplot_core.f90.

Member Function/Subroutine Documentation

◆ define_data()

procedure, public fplot_core::surface_plot_data::define_data

Defines the data set.

Syntax: subroutine define_data(class(surface_plot_data) this, real(real64) x(:,:), real(real64) y(:,:), real(real64) z(:,:))

Parameters

[in,out]	this	The surface_plot_data object.
[in]	x	An M-by-N matrix containing the x-coordinate data.
[in]	y	An M-by-N matrix containing the y-coordinate data.
[in]	z	An M-by-N matrix containing the z-coordinate data.
[out]	err	An optional errors-based object that if provided can be used to retrieve information relating to any errors encountered during execution. If not provided, a default implementation of the errors class is used internally to provide error handling. Possible errors and warning messages that may be encountered are as follows. PLOT_OUT_OF_MEMORY_ERROR: Occurs if insufficient memory is available. PLOT_ARRAY_SIZE_MISMATCH_ERROR: Occurs if `x`, `y`, and `z` are not the same size.

Definition at line 4760 of file fplot_core.f90.

◆ get_command_string()

procedure, public fplot_core::surface_plot_data::get_command_string

virtual

Gets the GNUPLOT command string to represent this surface_plot_data object.

Syntax: character(len = :) function, allocatable get_command_string(class(surface_plot_data) this)

Parameters

[in] this The surface_plot_data object.

Returns: The command string.

Implements fplot_core::plot_object.

Definition at line 4729 of file fplot_core.f90.

◆ get_data_string()

procedure, public fplot_core::surface_plot_data::get_data_string

virtual

Gets the GNUPLOT command string containing the actual data to plot.

Syntax: character(len = :) function, allocatable get_data_string(class(surface_plot_data) this)

Parameters

[in] this The surface_plot_data object.

Returns: The GNUPLOT command string.

Implements fplot_core::plot_data.

Definition at line 4740 of file fplot_core.f90.

◆ get_size()

procedure, public fplot_core::surface_plot_data::get_size

Gets the size of the stored data set.

Syntax: pure integer(int32) function get_size(class(surface_plot_data) this, integer(int32) dim)

Parameters

[in]	this	The suface_plot_data object.
[in]	dim	The dimension of interest. Notice, data is stored as a 2D matrix (i.e. only 1 and 2 are valid inputs).

Returns: The size of the requested dimension.

Definition at line 4622 of file fplot_core.f90.

◆ get_use_wireframe()

procedure, public fplot_core::surface_plot_data::get_use_wireframe

Gets a value determining if a wireframe mesh should be displayed.

Syntax: pure logical function get_wireframe(class(surface_plot_data) this)

Parameters

[in] this The surface_plot_data object.

Returns: Returns true if a wireframe mesh should be displayed; else, false to display a solid surface.

Definition at line 4706 of file fplot_core.f90.

◆ get_x()

procedure, public fplot_core::surface_plot_data::get_x

Gets the requested X data point.

Syntax: pure real(real64) function get_x(class(surface_plot_data) this, integer(int32) i, integer(int32) j)

Parameters

[in]	this	The surface_plot_data object.
[in]	i	The row index.
[in]	j	The column index.

Returns: The value.

Definition at line 4634 of file fplot_core.f90.

◆ get_y()

procedure, public fplot_core::surface_plot_data::get_y

Gets the requested Y data point.

Syntax: pure real(real64) function get_y(class(surface_plot_data) this, integer(int32) i, integer(int32) j)

Parameters

[in]	this	The surface_plot_data object.
[in]	i	The row index.
[in]	j	The column index.

Returns: The value.

Definition at line 4658 of file fplot_core.f90.

◆ get_z()

procedure, public fplot_core::surface_plot_data::get_z

Gets the requested Z data point.

Syntax: pure real(real64) function get_z(class(surface_plot_data) this, integer(int32) i, integer(int32) j)

Parameters

[in]	this	The surface_plot_data object.
[in]	i	The row index.
[in]	j	The column index.

Returns: The value.

Definition at line 4682 of file fplot_core.f90.

◆ set_use_wireframe()

procedure, public fplot_core::surface_plot_data::set_use_wireframe

Sets a value determining if a wireframe mesh should be displayed.

Syntax: subroutine set_wireframe(class(surface_plot_data) this, logical x)

Parameters

[in,out]	this	The surface_plot_data object.
[in]	x	Set to true if a wireframe mesh should be displayed; else, false to display a solid surface.

Definition at line 4718 of file fplot_core.f90.

◆ set_x()

procedure, public fplot_core::surface_plot_data::set_x

Sets the requested X data point.

Syntax: subroutine set_x(class(surface_plot_data) this, integer(int32) i, integer(int32) j, real(real64) x)

Parameters

[in,out]	this	The surface_plot_data object.
[in]	i	The row index.
[in]	j	The column index.
[in]	x	The value.

Definition at line 4646 of file fplot_core.f90.

◆ set_y()

procedure, public fplot_core::surface_plot_data::set_y

Sets the requested Y data point.

Syntax: subroutine set_y(class(surface_plot_data) this, integer(int32) i, integer(int32) j, real(real64) x)

Parameters

[in,out]	this	The surface_plot_data object.
[in]	i	The row index.
[in]	j	The column index.
[in]	x	The value.

Definition at line 4670 of file fplot_core.f90.

◆ set_z()

procedure, public fplot_core::surface_plot_data::set_z

Sets the requested Z data point.

Syntax: subroutine set_z(class(surface_plot_data) this, integer(int32) i, integer(int32) j, real(real64) x)

Parameters

[in,out]	this	The surface_plot_data object.
[in]	i	The row index.
[in]	j	The column index.
[in]	x	The value.

Definition at line 4694 of file fplot_core.f90.

Member Data Documentation

◆ m_wireframe

logical fplot_core::surface_plot_data::m_wireframe = .false.

Set to true to display a wireframe of the surface; else, just a smooth surface will be drawn.

Definition at line 4609 of file fplot_core.f90.

◆ m_x

real(real64), dimension(:,:), allocatable fplot_core::surface_plot_data::m_x

private

Stores the x-coordinate data.

Definition at line 4602 of file fplot_core.f90.

◆ m_y

real(real64), dimension(:,:), allocatable fplot_core::surface_plot_data::m_y

Stores the y-coordinate data.

Definition at line 4604 of file fplot_core.f90.

◆ m_z

real(real64), dimension(:,:), allocatable fplot_core::surface_plot_data::m_z

Stores the z-coordinate data.

Definition at line 4606 of file fplot_core.f90.

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

D:/Code/fplot-1/src/fplot_core.f90

Public Member Functions

Public Attributes

Private Attributes

Detailed Description

Member Function/Subroutine Documentation

◆ define_data()

◆ get_command_string()

◆ get_data_string()

◆ get_size()

◆ get_use_wireframe()

◆ get_x()

◆ get_y()

◆ get_z()

◆ set_use_wireframe()

◆ set_x()

◆ set_y()

◆ set_z()

Member Data Documentation

◆ m_wireframe

◆ m_x

◆ m_y

◆ m_z