xdmf_plot_file Type Reference

Detailed Description

Information for XDMF plotting groups in HDF5 plot file.

Public Member Functions
procedure	add_mesh (self, mesh_type, pt_list, cell_list, grid_name)
	Needs docs.
procedure	add_timestep (self, t)
	Adds a timestep to the dump metadata file.
procedure	clear_timesteps (self, clear_static)
	Clear existing timesteps and reset to static fields.
procedure	setup (self, group_name, basepath, persistent_space_tracking)
	Needs docs.
GENERIC	write write_scalar, write_vector
procedure	write_scalar (self, data, grid_name, path, centering, single_prec)
	Write scalar field to plot file.
procedure	write_vector (self, data, grid_name, path, centering, single_prec)
	Write vector field to plot file.

Public Attributes
integer(i4)	curr_ts = 0
character(len=oft_path_slen)	file_path = ''
character(len=oft_path_slen), dimension(10)	grid_names = ''
character(len=oft_path_slen)	group_name = ''
integer(i4)	n_grids = 0
integer(i4)	n_ts = 0

Member Function/Subroutine Documentation

add_mesh()

procedure add_mesh	(	class(xdmf_plot_file), intent(inout)	self,
		integer(i4), intent(in)	mesh_type,
		real(r8), dimension(:,:), intent(in)	pt_list,
		integer(i4), dimension(:,:), intent(in)	cell_list,
		character(len=*), intent(in)	grid_name )

Needs docs.

Parameters

[in]	mesh_type	Mesh type flag (Tet/Tri or Hex/Quad)
[in]	pt_list	Point list [3,np]
[in]	cell_list	Cell list [:,nc]
[in]	grid_name	Path to mesh in HDF5 file

add_timestep()

procedure add_timestep	(	class(xdmf_plot_file), intent(inout)	self,
		real(r8), intent(in)	t )

Adds a timestep to the dump metadata file.

Subsequent output will be added to this timestep until another call to this subroutine

Parameters

[in]

t

Time value

clear_timesteps()

procedure clear_timesteps	(	class(xdmf_plot_file), intent(inout)	self,
		logical, intent(in), optional	clear_static )

Clear existing timesteps and reset to static fields.

Parameters

[in]

clear_static

Clear static fields as well?

setup()

procedure setup	(	class(xdmf_plot_file), intent(inout)	self,
		character(len=*), intent(in)	group_name,
		character(len=*), intent(in), optional	basepath,
		logical, intent(in), optional	persistent_space_tracking )

Needs docs.

Parameters

[in]

group_name

Path to mesh in HDF5 file

write()

GENERIC write

write_scalar()

procedure write_scalar	(	class(xdmf_plot_file), intent(in)	self,
		real(r8), dimension(:), intent(in)	data,
		character(len=*), intent(in)	grid_name,
		character(len=*), intent(in)	path,
		integer(i4), intent(in)	centering,
		logical, intent(in), optional	single_prec )

Write scalar field to plot file.

Parameters

[in]	data	Scalar data
[in]	grid_name	Grid name
[in]	path	Name of the output field
[in]	centering	Centering of data (1-> vertex; 2-> cell)
[in]	single_prec	Save as single precision?

write_vector()

procedure write_vector	(	class(xdmf_plot_file), intent(in)	self,
		real(r8), dimension(:,:), intent(in)	data,
		character(len=*), intent(in)	grid_name,
		character(len=*), intent(in)	path,
		integer(i4), intent(in)	centering,
		logical, intent(in), optional	single_prec )

Write vector field to plot file.

Parameters

[in]	data	Vector data
[in]	grid_name	Grid name
[in]	path	Name of the output field
[in]	centering	Centering of data (1-> vertex; 2-> cell)
[in]	single_prec	Save as single precision?

Member Data Documentation

curr_ts

integer(i4) curr_ts = 0

file_path

character(len=oft_path_slen) file_path = ''

grid_names

character(len=oft_path_slen), dimension(10) grid_names = ''

group_name

character(len=oft_path_slen) group_name = ''

n_grids

integer(i4) n_grids = 0

n_ts

integer(i4) n_ts = 0

---

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

• /home/runner/work/OpenFUSIONToolkit/OpenFUSIONToolkit/src/base/oft_io.F90