lpt_output Module Reference

Output support for Lagrangian particle tracking.

Data Types
type	lpt_output_t

Functions/Subroutines
subroutine	lpt_output_init (this, output_path, inertia, snapshots_per_file)
	Initialise the LPT output writer.
subroutine	lpt_output_init_file (this)
	Initialise the currently active LPT output file.
subroutine	lpt_output_current_path (this, output_path)
	Get the active output path, adding a file index when chunked output is on.
subroutine	lpt_output_init_hdf5 (this, output_path, inertia)
	Initialise an HDF5 LPT trajectory file.
subroutine	lpt_output_write (this, local_data, n_local)
	Write one trajectory snapshot.
subroutine	lpt_output_write_hdf5 (this, local_data, n_local)
	Append one local LPT trajectory snapshot to an HDF5 file.
subroutine	lpt_output_write_csv (this, local_data, n_local)
	Write one trajectory snapshot to CSV by gathering particle data to rank 0.
subroutine	lpt_output_free (this)
	Free the output writer and reset file/output counters.

Function/Subroutine Documentation

lpt_output_current_path()

subroutine lpt_output::lpt_output_current_path ( class(lpt_output_t), intent(in)  this, character(len=*), intent(out)  output_path  )

private

Parameters

output_path

Path selected for the current output file.

Definition at line 126 of file lpt_output.f90.

Here is the call graph for this function:

lpt_output_free()

subroutine lpt_output::lpt_output_free ( class(lpt_output_t), intent(inout)  this )

private

Definition at line 351 of file lpt_output.f90.

lpt_output_init()

subroutine lpt_output::lpt_output_init	(	class(lpt_output_t), intent(inout)	this,
		character(len=*), intent(in)	output_path,
		logical, intent(in)	inertia,
		integer, intent(in)	snapshots_per_file
	)

Parameters

output_path	Base output path, including csv/hdf5 suffix.
inertia	Whether particle records include diameter and density.
snapshots_per_file	Number of snapshots per file, or 0 for all.

Definition at line 73 of file lpt_output.f90.

lpt_output_init_file()

subroutine lpt_output::lpt_output_init_file ( class(lpt_output_t), intent(inout)  this )

private

Definition at line 94 of file lpt_output.f90.

Here is the call graph for this function:

lpt_output_init_hdf5()

subroutine lpt_output::lpt_output_init_hdf5 ( class(lpt_output_t), intent(inout)  this, character(len=*), intent(in)  output_path, logical, intent(in)  inertia  )

private

Parameters

output_path	HDF5 file path to initialise.
inertia	Whether particle records include diameter and density.

Definition at line 143 of file lpt_output.f90.

lpt_output_write()

subroutine lpt_output::lpt_output_write ( class(lpt_output_t), intent(inout)  this, real(kind=rp), dimension(this%n_data, n_local), intent(in)  local_data, integer, intent(in)  n_local  )

private

Parameters

local_data	Particle data owned by this rank.
n_local	Number of local particles.

Definition at line 199 of file lpt_output.f90.

lpt_output_write_csv()

subroutine lpt_output::lpt_output_write_csv ( class(lpt_output_t), intent(inout)  this, real(kind=rp), dimension(this%n_data, n_local), intent(in)  local_data, integer, intent(in)  n_local  )

private

Parameters

local_data	Particle data owned by this rank.
n_local	Number of local particles.

Definition at line 291 of file lpt_output.f90.

Here is the call graph for this function:

lpt_output_write_hdf5()

subroutine lpt_output::lpt_output_write_hdf5 ( class(lpt_output_t), intent(inout)  this, real(kind=rp), dimension(this%n_data, n_local), intent(in)  local_data, integer, intent(in)  n_local  )

private

Parameters

local_data	Particle data owned by this rank.
n_local	Number of local particles.

Definition at line 221 of file lpt_output.f90.