ngadata_obj Derived Type

type, public :: ngadata_obj

A utility to read NGA data files

Inherits

Help

Components

Type	Visibility	Attributes		Name		Initial
type(block_obj),	public,	pointer	::	block	=>	null()	Associated block structure
type(MPI_Datatype),	public		::	block_i4	=	MPI_DATATYPE_NULL	MPI derived type for integer block
type(MPI_Datatype),	public		::	block_r4	=	MPI_DATATYPE_NULL	MPI derived type for SP real block
type(MPI_Datatype),	public		::	block_r8	=	MPI_DATATYPE_NULL	MPI derived type for DP real block
real(kind=leapDP),	public		::	dt			Time step in file
integer,	public,	allocatable	::	etypes(:)			Element types
type(MPI_File),	public		::	fid			File identifier
character(len=str64),	public		::	filename			file to read/write
type(MPI_Info),	public		::	mpi_info			MPI info
character(len=str8),	public,	allocatable	::	names(:)			Names of variables in file
integer,	public		::	nx(3)			Grid size
type(parallel_obj),	public,	pointer	::	parallel	=>	null()	Associated parallel structure
real(kind=leapDP),	public		::	time			Time in file

Type-Bound Procedures

procedure, public :: Close => ngadata_obj_Close

private subroutine ngadata_obj_Close(this)

Close file with MPI

Arguments

Type	Intent	Optional	Attributes		Name
class(ngadata_obj),	intent(inout)			::	this	A NGAbin object

procedure, public :: Finalize => ngadata_obj_Final

private subroutine ngadata_obj_Final(this)

Finalize structure

Arguments

Type	Intent	Optional	Attributes		Name
class(ngadata_obj),	intent(inout)			::	this	A NGAbin object

procedure, public :: GetAttributes => ngadata_obj_GetAttributes

private subroutine ngadata_obj_GetAttributes(this)

Read file attributes

Arguments

Type	Intent	Optional	Attributes		Name
class(ngadata_obj),	intent(inout)			::	this	A NGAbin object

procedure, public :: Initialize => ngadata_obj_Init

private subroutine ngadata_obj_Init(this, filename, access_flag, block, parallel)

Initialize structure

Arguments

Type	Intent	Optional	Attributes		Name
class(ngadata_obj),	intent(inout)			::	this	A NGAbin object
character(len=*),	intent(in)			::	filename	File to read/write
character(len=*),	intent(in)			::	access_flag	File access mode
type(block_obj),	intent(in),		target	::	block	A block object
type(parallel_obj),	intent(in),		target	::	parallel	parallel structure from main program

procedure, public :: Open => ngadata_obj_Open

private subroutine ngadata_obj_Open(this, flag)

Open a hdf5 file with ngadata

Arguments

Type	Intent	Optional	Attributes		Name
class(ngadata_obj),	intent(inout)			::	this	A NGAbin object
character(len=*),	intent(in)			::	flag	File access flag

procedure, public :: SetView3D => ngadata_obj_SetView3D

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

Set the file view

Arguments

Type	Intent	Optional	Attributes		Name
class(ngadata_obj),	intent(inout)			::	this	A NGAbin 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

procedure, public :: SetupMPITypes => ngadata_obj_SetupMPITypes

private subroutine ngadata_obj_SetupMPITypes(this)

Create MPI types needed for IO

Arguments

Type	Intent	Optional	Attributes		Name
class(ngadata_obj),	intent(inout)			::	this	A NGAbin object

procedure, public :: read => ngadata_obj_ReadScalar3D

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

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

Arguments

Type	Intent	Optional	Attributes		Name
class(ngadata_obj),	intent(inout)			::	this	A NGAbin 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