leapIO_h5hut Module

Read/write data in the HDF5 format using H5hut


Uses

  • module~~leapio_h5hut~~UsesGraph module~leapio_h5hut leapIO_h5hut h5hut h5hut module~leapio_h5hut->h5hut module~leapkinds leapKinds module~leapio_h5hut->module~leapkinds module~leapparallel leapParallel module~leapio_h5hut->module~leapparallel iso_fortran_env iso_fortran_env module~leapkinds->iso_fortran_env module~leapparallel->module~leapkinds module~leapparser leapParser module~leapparallel->module~leapparser mpi_f08 mpi_f08 module~leapparallel->mpi_f08 module~leapparser->module~leapkinds module~leapcli leapCli module~leapparser->module~leapcli module~leapcli->module~leapkinds

Used by

  • module~~leapio_h5hut~~UsedByGraph module~leapio_h5hut leapIO_h5hut module~leapio leapIO module~leapio->module~leapio_h5hut module~immersed_boundaries_markers immersed_boundaries_markers module~immersed_boundaries_markers->module~leapio module~leapeulerian leapEulerian module~immersed_boundaries_markers->module~leapeulerian module~leaplagrangian leapLagrangian module~immersed_boundaries_markers->module~leaplagrangian module~leapdiffop leapDiffOp module~immersed_boundaries_markers->module~leapdiffop module~leaphypre leapHypre module~immersed_boundaries_markers->module~leaphypre module~immersed_boundaries_solids immersed_boundaries_solids module~immersed_boundaries_solids->module~leapio module~immersed_boundaries_solids->module~immersed_boundaries_markers module~immersed_boundaries_solids->module~leapeulerian module~immersed_boundaries_solids->module~leaplagrangian module~leapeulerian->module~leapio module~leaplagrangian->module~leapio module~particles_point particles_point module~particles_point->module~leapio module~particles_point->module~leapeulerian module~particles_point->module~leaplagrangian module~particles_resolved particles_resolved module~particles_resolved->module~leapio module~particles_resolved->module~leapeulerian module~particles_resolved->module~leaplagrangian module~immersed_boundaries immersed_boundaries module~particles_resolved->module~immersed_boundaries module~particles_resolved->module~leapdiffop proc~bc_set_read bc_set%bc_set_Read proc~bc_set_read->module~leapio proc~bc_set_write bc_set%bc_set_Write proc~bc_set_write->module~leapio module~cdifs cdifs module~cdifs->module~leapeulerian module~cdifs->module~particles_resolved module~cdifs_cases cdifs_cases module~cdifs->module~cdifs_cases module~cdifs->module~immersed_boundaries module~leapbc leapBC module~cdifs->module~leapbc module~cdifs->module~leapdiffop module~cdifs->module~leaphypre module~cdifs_cases->module~leapeulerian module~grans grans module~grans->module~leapeulerian module~grans->module~particles_point module~grans->module~particles_resolved module~grans_cases grans_cases module~grans->module~grans_cases module~grans->module~immersed_boundaries module~grans->module~leaphypre module~grans_cases->module~leapeulerian module~grans_cases->module~particles_point module~grans_cases->module~particles_resolved module~grans_cases->module~immersed_boundaries module~immersed_boundaries->module~immersed_boundaries_markers module~immersed_boundaries->module~immersed_boundaries_solids module~leapbc->module~leapeulerian module~leapdiffop->module~leapeulerian module~leapdiffop->module~leapbc module~leaphypre->module~leapeulerian module~nga_smod nga_smod module~nga_smod->module~particles_point proc~add_markers add_markers proc~add_markers->module~particles_resolved proc~add_markers->module~immersed_boundaries proc~add_markers~2 add_markers proc~add_markers~2->module~particles_resolved proc~add_markers~2->module~immersed_boundaries proc~bc_set_buildmask bc_set%bc_set_BuildMask proc~bc_set_buildmask->module~leapeulerian proc~cdifs_rebound_respart cdifs_rebound_ResPart proc~cdifs_rebound_respart->module~particles_resolved proc~cdifs_settling_sphere_respart cdifs_settling_sphere_ResPart proc~cdifs_settling_sphere_respart->module~particles_resolved module~cavity_smod cavity_smod module~cavity_smod->module~cdifs_cases module~cdifs_advancesolution_smod cdifs_AdvanceSolution_smod module~cdifs_advancesolution_smod->module~cdifs module~cdifs_monitor_smod cdifs_Monitor_smod module~cdifs_monitor_smod->module~cdifs module~cdifs_preparesolver_smod cdifs_PrepareSolver_smod module~cdifs_preparesolver_smod->module~cdifs module~cdifs_writeoutputdata_smod cdifs_WriteOutputData_smod module~cdifs_writeoutputdata_smod->module~cdifs module~cdifs_writerestartdata_smod cdifs_WriteRestartData_smod module~cdifs_writerestartdata_smod->module~cdifs module~channel_flow_smod channel_flow_smod module~channel_flow_smod->module~cdifs_cases module~cylinder_smod cylinder_smod module~cylinder_smod->module~cdifs_cases module~grans_advancesolution_smod grans_AdvanceSolution_smod module~grans_advancesolution_smod->module~grans module~grans_module_smod grans_module_smod module~grans_module_smod->module~grans module~grans_preparesolver_smod grans_PrepareSolver_smod module~grans_preparesolver_smod->module~grans module~grans_writeoutputdata_smod grans_WriteOutputData_smod module~grans_writeoutputdata_smod->module~grans module~grans_writerestartdata_smod grans_WriteRestartData_smod module~grans_writerestartdata_smod->module~grans module~headon_collision_smod headon_collision_smod module~headon_collision_smod->module~grans_cases module~homogeneous_cooling_smod homogeneous_cooling_smod module~homogeneous_cooling_smod->module~grans_cases module~lamb_oseen_smod lamb_oseen_smod module~lamb_oseen_smod->module~cdifs_cases module~rebound_smod rebound_smod module~rebound_smod->module~cdifs_cases module~rotating_drum_smod rotating_drum_smod module~rotating_drum_smod->module~grans_cases module~settling_sphere_smod settling_sphere_smod module~settling_sphere_smod->module~cdifs_cases module~taylor_green_smod taylor_green_smod module~taylor_green_smod->module~cdifs_cases module~vortex_dipole_smod vortex_dipole_smod module~vortex_dipole_smod->module~cdifs_cases module~vortex_impingement_smod vortex_impingement_smod module~vortex_impingement_smod->module~cdifs_cases proc~cdifs_channel_flow_bcs cdifs_channel_flow_bcs proc~cdifs_channel_flow_bcs->module~leapbc proc~cdifs_cylinder_bcs cdifs_cylinder_bcs proc~cdifs_cylinder_bcs->module~leapbc proc~cdifs_cylinder_ib cdifs_cylinder_IB proc~cdifs_cylinder_ib->module~immersed_boundaries proc~cdifs_lamb_oseen_bcs cdifs_lamb_oseen_bcs proc~cdifs_lamb_oseen_bcs->module~leapbc proc~cdifs_lid_driven_cavity_bcs cdifs_lid_driven_cavity_bcs proc~cdifs_lid_driven_cavity_bcs->module~leapbc proc~cdifs_obj_preparesolveroperators cdifs_obj_PrepareSolverOperators proc~cdifs_obj_preparesolveroperators->module~leapbc proc~cdifs_obj_preparesolveroperatorsdiv cdifs_obj_PrepareSolverOperatorsDIV proc~cdifs_obj_preparesolveroperatorsdiv->module~leapbc proc~cdifs_obj_preparesolveroperatorspgrad cdifs_obj_PrepareSolverOperatorsPGRAD proc~cdifs_obj_preparesolveroperatorspgrad->module~leapbc proc~cdifs_obj_preparesolveroperatorsvlap cdifs_obj_PrepareSolverOperatorsVLAP proc~cdifs_obj_preparesolveroperatorsvlap->module~leapbc proc~cdifs_rebound_bcs cdifs_rebound_bcs proc~cdifs_rebound_bcs->module~leapbc proc~cdifs_rebound_ib cdifs_rebound_IB proc~cdifs_rebound_ib->module~immersed_boundaries proc~cdifs_settling_sphere_bcs cdifs_settling_sphere_bcs proc~cdifs_settling_sphere_bcs->module~leapbc proc~cdifs_settling_sphere_ib cdifs_settling_sphere_IB proc~cdifs_settling_sphere_ib->module~immersed_boundaries proc~cdifs_taylor_green_bcs cdifs_taylor_green_bcs proc~cdifs_taylor_green_bcs->module~leapbc proc~cdifs_vortex_dipole_bcs cdifs_vortex_dipole_bcs proc~cdifs_vortex_dipole_bcs->module~leapbc proc~cdifs_vortex_impingement_bcs cdifs_vortex_impingement_bcs proc~cdifs_vortex_impingement_bcs->module~leapbc proc~grans_obj_preparesolver_operators grans_obj_PrepareSolver_operators proc~grans_obj_preparesolver_operators->module~leapdiffop proc~marker_set_computesolidvolfrac marker_set%marker_set_ComputeSolidVolFrac proc~marker_set_computesolidvolfrac->module~leapdiffop proc~op_obj_applylaplaciandc op_obj%op_obj_ApplyLaplacianDC proc~op_obj_applylaplaciandc->module~leapbc program~main main program~main->module~cdifs program~main->module~grans

Derived Types

type, public ::  h5hut_obj

A utility to read/write files in HDF5 using H5hut

Components

Type Visibility Attributes Name Initial
integer(kind=leapI8), public :: fid

File identifier
character(len=str64), public :: filename

file to read/write
type(parallel_obj), public, pointer :: parallel => null()

Associated parallel structure

Type-Bound Procedures

procedure, public :: Close => h5hut_Close
procedure, public :: Finalize => h5hut_Final
procedure, public :: Flush => h5hut_Flush
procedure, public :: GetNFields => h5hut_GetNFields
procedure, public :: GetNPoints => h5hut_GetNPoints
procedure, public :: Initialize => h5hut_Init
procedure, public :: JumpToStep => h5hut_JumpToStep
procedure, public :: LastTimeStep => h5hut_LastTimeStep
procedure, public :: NewTimeStep => h5hut_NewTimeStep
procedure, public :: Open => h5hut_Open
generic, public :: Read => h5hut_Read1D, h5hut_ReadScalar3D
generic, public :: ReadAttributes => h5hut_ReadAttributes0D, h5hut_ReadAttributes1D
procedure, public :: StepCount => h5hut_StepCount
generic, public :: Write => h5hut_Write1D, h5hut_WriteScalar3D
generic, public :: WriteAttributes => h5hut_WriteAttributes0D, h5hut_WriteAttributes1D
procedure, public :: WriteGrid => h5hut_WriteGrid
procedure, private :: h5hut_Read1D
procedure, private :: h5hut_ReadAttributes0D
procedure, private :: h5hut_ReadAttributes1D
procedure, private :: h5hut_ReadScalar3D
procedure, private :: h5hut_Write1D
procedure, private :: h5hut_WriteAttributes0D
procedure, private :: h5hut_WriteAttributes1D
procedure, private :: h5hut_WriteScalar3D

Functions

private function h5hut_StepCount(this) result(steps4)

Return number of time steps

Arguments

Type IntentOptional Attributes Name
class(h5hut_obj), intent(inout) :: this

A H5hut object

Return Value integer

Number of steps


Subroutines

private subroutine h5hut_Close(this)

Close hdf5 file with h5hut

Arguments

Type IntentOptional Attributes Name
class(h5hut_obj), intent(inout) :: this

A H5hut object

private subroutine h5hut_Final(this)

Finalize structure

Arguments

Type IntentOptional Attributes Name
class(h5hut_obj), intent(inout) :: this

A H5hut object

private subroutine h5hut_Flush(this)

Flush step data to disk

Arguments

Type IntentOptional Attributes Name
class(h5hut_obj), intent(inout) :: this

A H5hut object

private subroutine h5hut_GetNFields(this, nfields)

Get number of fields in step

Arguments

Type IntentOptional Attributes Name
class(h5hut_obj), intent(inout) :: this

A H5hut object
integer, intent(out) :: nfields

Number of fields

private subroutine h5hut_GetNPoints(this, npoints)

Get number of data points in step

Arguments

Type IntentOptional Attributes Name
class(h5hut_obj), intent(inout) :: this

A H5hut object
integer, intent(out) :: npoints

Number of data points

private subroutine h5hut_Init(this, filename, access_flag, parallel)

Initialize structure

Arguments

Type IntentOptional Attributes Name
class(h5hut_obj), intent(inout) :: this

A H5hut object
character(len=*), intent(in) :: filename

File to read/write
character(len=*), intent(in) :: access_flag

File access mode
type(parallel_obj), intent(in), target :: parallel

parallel structure from main program

private subroutine h5hut_JumpToStep(this, step, iter, time, label_iter, label_time)

Jump to a specific time step

Arguments

Type IntentOptional Attributes Name
class(h5hut_obj), intent(inout) :: this

A H5hut object
integer, intent(in) :: step

Time step
integer, intent(out) :: iter

Iteration number at this time step
real(kind=WP), intent(out) :: time

Time at this time step
character(len=*), intent(in), optional :: label_iter

Optional iteration label
character(len=*), intent(in), optional :: label_time

Optional time label

private subroutine h5hut_LastTimeStep(this, iter, time, label_iter, label_time)

Get information about the last time step

Arguments

Type IntentOptional Attributes Name
class(h5hut_obj), intent(inout) :: this

A H5hut object
integer, intent(out) :: iter

last step
real(kind=WP), intent(out) :: time

Time of last step
character(len=*), intent(in), optional :: label_iter

Optional iteration label
character(len=*), intent(in), optional :: label_time

Optional time label

private subroutine h5hut_NewTimeStep(this, iter, time, label_iter, label_time)

Create a new time step and update attributes

Arguments

Type IntentOptional Attributes Name
class(h5hut_obj), intent(inout) :: this

A H5hut object
integer, intent(in) :: iter

iteration counter
real(kind=WP), intent(in) :: time

iteration counter
character(len=*), intent(in), optional :: label_iter

Optional iteration label
character(len=*), intent(in), optional :: label_time

Optional time label

private subroutine h5hut_Open(this, flag)

Open a hdf5 file with h5hut

Arguments

Type IntentOptional Attributes Name
class(h5hut_obj), intent(inout) :: this

A H5hut object
character(len=*), intent(in) :: flag

private subroutine h5hut_Read1D(this, name, array)

Read Lagrangian/1D data fom a hdf5 file with h5hut

Arguments

Type IntentOptional Attributes Name
class(h5hut_obj), intent(inout) :: this

A H5hut object
character(len=*), intent(in) :: name

Variable name
class(*), intent(out) :: array(:)

1-D data array

private subroutine h5hut_ReadAttributes0D(this, label, val)

Read scalar attributes

Arguments

Type IntentOptional Attributes Name
class(h5hut_obj), intent(inout) :: this

A H5hut object
character(len=*), intent(in) :: label

attribute label
class(*), intent(out) :: val

Optional time label

private subroutine h5hut_ReadAttributes1D(this, label, val)

Read an array of attributes

Arguments

Type IntentOptional Attributes Name
class(h5hut_obj), intent(inout) :: this

A H5hut object
character(len=*), intent(in) :: label

attribute label
class(*), intent(out) :: val(:)

Optional time label

private subroutine h5hut_ReadScalar3D(this, name, array, lo, hi)

Read Eulerian/3D data from a hdf5 file with h5hut

Arguments

Type IntentOptional Attributes Name
class(h5hut_obj), intent(inout) :: this

A H5hut object
character(len=*), intent(in) :: name

Variable name
class(*), intent(out) :: array(:,:,:)

3-D data array
integer, intent(in) :: lo(3)

Low bounds
integer, intent(in) :: hi(3)

High bounds

private subroutine h5hut_Write1D(this, name, array)

Write Lagrangian/1D data to a hdf5 file with h5hut

Arguments

Type IntentOptional Attributes Name
class(h5hut_obj), intent(inout) :: this

A H5hut object
character(len=*), intent(in) :: name

Variable name
class(*), intent(in) :: array(:)

1-D data array

private subroutine h5hut_WriteAttributes0D(this, label, val)

Write scalar attributes

Arguments

Type IntentOptional Attributes Name
class(h5hut_obj), intent(inout) :: this

A H5hut object
character(len=*), intent(in) :: label

attribute label
class(*), intent(in) :: val

Optional time label

private subroutine h5hut_WriteAttributes1D(this, label, val)

Write an array of attributes

Arguments

Type IntentOptional Attributes Name
class(h5hut_obj), intent(inout) :: this

A H5hut object
character(len=*), intent(in) :: label

attribute label
class(*), intent(in) :: val(:)

Optional time label

private subroutine h5hut_WriteGrid(this, name, xlo, dx)

Write the grid attributes

Arguments

Type IntentOptional Attributes Name
class(h5hut_obj), intent(inout) :: this

A H5hut object
character(len=*), intent(in) :: name

Variable name
real(kind=wp), intent(in) :: xlo(3)

Coordinate of the low bound
real(kind=wp), intent(in) :: dx(3)

Grid spacing

private subroutine h5hut_WriteScalar3D(this, name, array, lo, hi)

Write Eulerian/3D data to a hdf5 file with h5hut

Arguments

Type IntentOptional Attributes Name
class(h5hut_obj), intent(inout) :: this

A H5hut object
character(len=*), intent(in) :: name

Variable name
class(*), intent(in) :: array(:,:,:)

3-D data array
integer, intent(in) :: lo(3)

Low bounds
integer, intent(in) :: hi(3)

High bounds