block_obj – LEAP

type, public :: block_obj

A block object

Inherits

Help

Inherited by

Help

Components

Type	Visibility	Attributes		Name		Initial
type(axis_obj),	public		::	axis(3)			Axes in x1, x2, and x3 directions
type(axis_obj),	public		::	axis_partition(3)			Axes of the main partition, (spacing equal to 1 sub-block)
real(kind=wp),	public		::	dx(3)			Minimum mesh spacing in each direction
real(kind=wp),	public,	contiguous, pointer	::	dxm(:)	=>	null()	Convenience pointer to x-cell spacings
real(kind=wp),	public,	contiguous, pointer	::	dym(:)	=>	null()	Convenience pointer to y-cell spacings
real(kind=wp),	public,	contiguous, pointer	::	dzm(:)	=>	null()	Convenience pointer to z-cell spacings
type(MPI_Datatype),	public		::	gc_slab_i(3)			MPI derived type for integer gc
type(MPI_Datatype),	public		::	gc_slab_r(3)			MPI derived type for wp real gc
type(hdf5_obj),	public,	pointer	::	hdf5	=>	null()	HDF5 object for IO
integer,	public		::	hi(3)			Array upper bound
logical,	public		::	is_initialized	=	.false.	Flag to determine whether this has been initialized
logical,	public		::	is_partitioned	=	.false.	Flag for parallel partitioning
integer,	public		::	lo(3)			Array lower bound
integer,	public		::	ngc	=	2	Number of ghostcells
type(parallel_obj),	public,	pointer	::	parallel	=>	null()	Associated parallel structure
logical,	public		::	periods(3)	=	.false.	Periodicity in each direction
real(kind=wp),	public		::	pmax(3)			Min and max locations across all blocks
real(kind=wp),	public		::	pmin(3)			Min and max locations across all blocks
real(kind=wp),	public,	contiguous, pointer	::	x(:)	=>	null()	Convenience pointer to x-nodal points
real(kind=wp),	public		::	xhi(3)			Coordinate of the top right corner
real(kind=wp),	public		::	xlo(3)			Coordinate of the bottom left corner
real(kind=wp),	public,	contiguous, pointer	::	xm(:)	=>	null()	Convenience pointer to x-mid points
real(kind=wp),	public		::	xmax			Min and max locations across all blocks
real(kind=wp),	public		::	xmin			Min and max locations across all blocks
real(kind=wp),	public,	contiguous, pointer	::	y(:)	=>	null()	Convenience pointer to y-nodal points
real(kind=wp),	public,	contiguous, pointer	::	ym(:)	=>	null()	Convenience pointer to y-mid points
real(kind=wp),	public		::	ymax			Min and max locations across all blocks
real(kind=wp),	public		::	ymin			Min and max locations across all blocks
real(kind=wp),	public,	contiguous, pointer	::	z(:)	=>	null()	Convenience pointer to z-nodal points
real(kind=wp),	public,	contiguous, pointer	::	zm(:)	=>	null()	Convenience pointer to z-mid points
real(kind=wp),	public		::	zmax			Min and max locations across all blocks
real(kind=wp),	public		::	zmin			Min and max locations across all blocks

Type-Bound Procedures

procedure, public :: Finalize => block_obj_Final

private impure subroutine block_obj_Final(this)

Finalizes the block object.

Arguments

Type	Intent	Optional	Attributes		Name
class(block_obj),	intent(inout)			::	this	A block object

procedure, public :: GetOwningCell => block_obj_GetOwningCell

private pure function block_obj_GetOwningCell(this, p) result(cell)

Returns the coordinates of the cell that contains the position p. This subroutine ignores gost cells. As such, it will always return an internal cell of the domain. If the point is located in a ghost cell, the returned cell will be an internal boundary cell that is closest to that ghost cell.

Arguments

Type	Intent	Optional	Attributes		Name
class(block_obj),	intent(in)			::	this	A block object
real(kind=wp),	intent(in)			::	p(3)	Position to locate

Return Value integer, (3)

Cell coordinates

procedure, public :: GetOwningCellWGC => block_obj_GetOwningCellWGC

private pure function block_obj_GetOwningCellWGC(this, p) result(cell)

Returns the coordinates of the cell that contains the position p, inclusive of ghost cells.

Arguments

Type	Intent	Optional	Attributes		Name
class(block_obj),	intent(in)			::	this	A block object
real(kind=wp),	intent(in)			::	p(3)	Position to locate

Return Value integer, (3)

Cell coordinates

procedure, public :: Info => block_obj_Info

private impure subroutine block_obj_Info(this)

Prints to stdout information about this block

Arguments

Type	Intent	Optional	Attributes		Name
class(block_obj),	intent(in)			::	this	A block object

generic, public :: Initialize => block_obj_Init, block_obj_Init2

private impure subroutine block_obj_Init(this, ngc, parallel)

Initializes block object.

Arguments

Type	Intent	Attributes		Name
class(block_obj),	intent(inout)		::	this	A block object
integer,	intent(in)		::	ngc	Number of ghostcells
type(parallel_obj),	intent(in),	target	::	parallel	Parallel structure to link with

private impure subroutine block_obj_Init2(this, xlo, xhi, lo, hi, ngc, parallel)

[DEPRECATED] Initializes block object.

Arguments

Type	Intent	Attributes		Name
class(block_obj),	intent(inout)		::	this	A block object
real(kind=wp),	intent(in)		::	xlo(3)	Coordinates of the bottom left corner
real(kind=wp),	intent(in)		::	xhi(3)	Coordinates of the top right corner
integer,	intent(in)		::	lo(3)	Array lower bound
integer,	intent(in)		::	hi(3)	Array upper bound
integer,	intent(in)		::	ngc	Number of ghostcells
type(parallel_obj),	intent(in),	target	::	parallel	Parallel structure to link with

procedure, public :: Locate => block_obj_Locate

private impure function block_obj_Locate(this, p) result(rank)

Returns block ID and rank of the block where the point is located using a binary search alogirthm. Note that this function assumes that the point is within the domain, i.e., (pmin <= p <= pmax) and that any treatment for periodicity has been previously applied.

Arguments

Type	Intent	Optional	Attributes		Name
class(block_obj),	intent(in)			::	this	A block object
real(kind=wp),	intent(in)			::	p(3)	Position to locate

Return Value integer

MPI rank

procedure, public :: Partition => block_obj_Partition

private impure subroutine block_obj_Partition(this, Nb)

Partitions a parent block into sub-blocks based on a given decomposition Nb(3) for parallel simulations. This will also define the partition axes, and update local bounds/extents, and global bounds/extents.

Arguments

Type	Intent	Optional	Attributes		Name
class(block_obj),	intent(inout)			::	this	A block object
integer,	intent(in)			::	Nb(3)	Number of blocks in each direction

procedure, public :: Read => block_obj_Read

private impure subroutine block_obj_Read(this, name)

Reads block data using HDF5.

Arguments

Type	Intent	Optional	Attributes		Name
class(block_obj),	intent(inout)			::	this	A block object
character(len=*),	intent(in)			::	name	Name of file to write

procedure, public :: SetConveniencePointers => block_obj_SetConveniencePointers

private pure subroutine block_obj_SetConveniencePointers(this)

Associate convenience pointers.

Arguments

Type	Intent	Optional	Attributes		Name
class(block_obj),	intent(inout)			::	this	A block object

procedure, public :: SetPeriodicity => block_obj_SetPeriodicity

private pure subroutine block_obj_SetPeriodicity(this, periods)

Sets block periodicity in each direction.

Arguments

Type	Intent	Optional	Attributes		Name
class(block_obj),	intent(inout)			::	this	A block object
logical,	intent(in)			::	periods(3)	Periodicity

procedure, public :: SetupMPITypes => block_obj_SetupMPITypes

private impure subroutine block_obj_SetupMPITypes(this)

Defines MPI derived type for communicating ghostcells.

Arguments

Type	Intent	Optional	Attributes		Name
class(block_obj),	intent(inout)			::	this	A block object

procedure, public :: SetupUniformGrid => block_obj_SetupUniformGrid

private impure subroutine block_obj_SetupUniformGrid(this, xlo, xhi, lo, hi)

Initializes a uniform grid on this block.

Arguments

Type	Intent		Name
class(block_obj),	intent(inout)	::	this	A block object
real(kind=wp),	intent(in)	::	xlo(3)	Coordinates of the bottom left corner
real(kind=wp),	intent(in)	::	xhi(3)	Coordinates of the top right corner
integer,	intent(in)	::	lo(3)	Array lower bound
integer,	intent(in)	::	hi(3)	Array upper bound

procedure, public, nopass :: SubDivideBlock => block_obj_SubDivideBlock

private pure subroutine block_obj_SubDivideBlock(coord, Nb, minlo, maxhi, sublo, subhi)

Computes the bounds of the sub-block form the bounds of the parent block. Each sub-block gets about the same number of grid points in each direction.

Arguments

Type	Intent		Name
integer,	intent(in)	::	coord(3)	Coordinates of MPI rank on MPI grid
integer,	intent(in)	::	Nb(3)	Number of blocks in each direction
integer,	intent(in)	::	minlo(3)	Global lo bounds
integer,	intent(in)	::	maxhi(3)	Global hi bounds
integer,	intent(out)	::	sublo(3)	lo bounds of sub-block
integer,	intent(out)	::	subhi(3)	hi bounds of sub-block

procedure, public :: UpdateExtents => block_obj_UpdateExtents

private impure subroutine block_obj_UpdateExtents(this)

Updates the dimensional extents of the block.

Arguments

Type	Intent	Optional	Attributes		Name
class(block_obj),	intent(inout)			::	this	A block object

procedure, public :: UpdateGridGhostCells => block_obj_UpdateGridGhostCells

private impure subroutine block_obj_UpdateGridGhostCells(this)

Updates the ghostcell values of local grid owned by the current MPI rank. Note that each MPI rank stores only its portion of the grid, thus needs to have proper ghostcell values.

Arguments

Type	Intent	Optional	Attributes		Name
class(block_obj),	intent(inout)			::	this	A block object

procedure, public :: UpdateMidPoints => block_obj_UpdateMidPoints

private pure subroutine block_obj_UpdateMidPoints(this)

Updates mid points.

Arguments

Type	Intent	Optional	Attributes		Name
class(block_obj),	intent(inout)			::	this	A block object

procedure, public :: UpdateSpacing => block_obj_UpdateSpacing

private impure subroutine block_obj_UpdateSpacing(this)

Updates grid spacing arrays.

Arguments

Type	Intent	Optional	Attributes		Name
class(block_obj),	intent(inout)			::	this	A block object

procedure, public :: Write => block_obj_Write

private impure subroutine block_obj_Write(this, name)

Writes block data using HDF5.

Arguments

Type	Intent	Optional	Attributes		Name
class(block_obj),	intent(in)			::	this	A block object
character(len=*),	intent(in)			::	name	Name of file to write

procedure, private :: block_obj_Init

private impure subroutine block_obj_Init(this, ngc, parallel)

Initializes block object.

Arguments

Type	Intent	Attributes		Name
class(block_obj),	intent(inout)		::	this	A block object
integer,	intent(in)		::	ngc	Number of ghostcells
type(parallel_obj),	intent(in),	target	::	parallel	Parallel structure to link with

procedure, private :: block_obj_Init2

private impure subroutine block_obj_Init2(this, xlo, xhi, lo, hi, ngc, parallel)

[DEPRECATED] Initializes block object.

Arguments

Type	Intent	Attributes		Name
class(block_obj),	intent(inout)		::	this	A block object
real(kind=wp),	intent(in)		::	xlo(3)	Coordinates of the bottom left corner
real(kind=wp),	intent(in)		::	xhi(3)	Coordinates of the top right corner
integer,	intent(in)		::	lo(3)	Array lower bound
integer,	intent(in)		::	hi(3)	Array upper bound
integer,	intent(in)		::	ngc	Number of ghostcells
type(parallel_obj),	intent(in),	target	::	parallel	Parallel structure to link with

Source Code

  type :: block_obj
    !> A block object
    type(parallel_obj),   pointer :: parallel        => null()                 !! Associated parallel structure
    type(hdf5_obj),       pointer :: hdf5            => null()                 !! HDF5 object for IO
    type(axis_obj)                :: axis(3)                                   !! Axes in x1, x2, and x3 directions
    integer                       :: lo(3)                                     !! Array lower bound
    integer                       :: hi(3)                                     !! Array upper bound
    real(wp)                      :: xlo(3)                                    !! Coordinate of the bottom left corner
    real(wp)                      :: xhi(3)                                    !! Coordinate of the top right corner
    integer                       :: ngc=2                                     !! Number of ghostcells
    real(wp), contiguous, pointer :: x(:)            => null()                 !! Convenience pointer to x-nodal points
    real(wp), contiguous, pointer :: y(:)            => null()                 !! Convenience pointer to y-nodal points
    real(wp), contiguous, pointer :: z(:)            => null()                 !! Convenience pointer to z-nodal points
    real(wp), contiguous, pointer :: xm(:)           => null()                 !! Convenience pointer to x-mid points
    real(wp), contiguous, pointer :: ym(:)           => null()                 !! Convenience pointer to y-mid points
    real(wp), contiguous, pointer :: zm(:)           => null()                 !! Convenience pointer to z-mid points
    real(wp), contiguous, pointer :: dxm(:)          => null()                 !! Convenience pointer to x-cell spacings
    real(wp), contiguous, pointer :: dym(:)          => null()                 !! Convenience pointer to y-cell spacings
    real(wp), contiguous, pointer :: dzm(:)          => null()                 !! Convenience pointer to z-cell spacings
    logical                       :: periods(3)       = .false.                !! Periodicity in each direction
    logical                       :: is_partitioned   = .false.                !! Flag for parallel partitioning
    type(axis_obj)                :: axis_partition(3)                         !! Axes of the main partition, (spacing equal to 1 sub-block)
    real(wp)                      :: dx(3)                                     !! Minimum mesh spacing in each direction
    real(wp)                      :: pmin(3),pmax(3)                           !! Min and max locations across all blocks
    real(wp)                      :: xmin,xmax                                 !! Min and max locations across all blocks
    real(wp)                      :: ymin,ymax                                 !! Min and max locations across all blocks
    real(wp)                      :: zmin,zmax                                 !! Min and max locations across all blocks
    type(MPI_Datatype)            :: gc_slab_r(3)                              !! MPI derived type for wp real gc
    type(MPI_Datatype)            :: gc_slab_i(3)                              !! MPI derived type for integer gc
    logical                       :: is_initialized    = .false.               !! Flag to determine whether this has been initialized
    contains
      generic   :: Initialize             => block_obj_Init, block_obj_Init2
      procedure :: Finalize               => block_obj_Final
      procedure :: SetConveniencePointers => block_obj_SetConveniencePointers
      procedure :: SetPeriodicity         => block_obj_SetPeriodicity
      procedure :: SetupUniformGrid       => block_obj_SetupUniformGrid
      procedure :: UpdateGridGhostCells   => block_obj_UpdateGridGhostCells
      procedure :: UpdateExtents          => block_obj_UpdateExtents
      procedure :: UpdateMidPoints        => block_obj_UpdateMidPoints
      procedure :: UpdateSpacing          => block_obj_UpdateSpacing
      procedure :: SetupMPITypes          => block_obj_SetupMPITypes
      procedure :: Partition              => block_obj_Partition
      procedure, &
         nopass :: SubDivideBlock         => block_obj_SubDivideBlock
      procedure :: Write                  => block_obj_Write
      procedure :: Read                   => block_obj_Read
      procedure :: Locate                 => block_obj_Locate
      procedure :: GetOwningCell          => block_obj_GetOwningCell
      procedure :: GetOwningCellWGC       => block_obj_GetOwningCellWGC
      procedure :: Info                   => block_obj_Info
      ! Internal/private procedures
      procedure, private :: block_obj_Init
      procedure, private :: block_obj_Init2
  end type block_obj

block_obj Derived Type

Contents

Variables

Type-Bound Procedures

Source Code

type, public :: block_obj

Inherits

Inherited by

Components

Type-Bound Procedures

procedure, public :: Finalize => block_obj_Final

private impure subroutine block_obj_Final(this)

Arguments

procedure, public :: GetOwningCell => block_obj_GetOwningCell

private pure function block_obj_GetOwningCell(this, p) result(cell)

Arguments

Return Value integer, (3)

procedure, public :: GetOwningCellWGC => block_obj_GetOwningCellWGC

private pure function block_obj_GetOwningCellWGC(this, p) result(cell)

Arguments

Return Value integer, (3)

procedure, public :: Info => block_obj_Info

private impure subroutine block_obj_Info(this)

Arguments

generic, public :: Initialize => block_obj_Init, block_obj_Init2

private impure subroutine block_obj_Init(this, ngc, parallel)

Arguments

private impure subroutine block_obj_Init2(this, xlo, xhi, lo, hi, ngc, parallel)

Arguments

procedure, public :: Locate => block_obj_Locate

private impure function block_obj_Locate(this, p) result(rank)

Arguments

Return Value integer

procedure, public :: Partition => block_obj_Partition

private impure subroutine block_obj_Partition(this, Nb)

Arguments

procedure, public :: Read => block_obj_Read

private impure subroutine block_obj_Read(this, name)

Arguments

procedure, public :: SetConveniencePointers => block_obj_SetConveniencePointers

private pure subroutine block_obj_SetConveniencePointers(this)

Arguments

procedure, public :: SetPeriodicity => block_obj_SetPeriodicity

private pure subroutine block_obj_SetPeriodicity(this, periods)

Arguments

procedure, public :: SetupMPITypes => block_obj_SetupMPITypes

private impure subroutine block_obj_SetupMPITypes(this)

Arguments

procedure, public :: SetupUniformGrid => block_obj_SetupUniformGrid

private impure subroutine block_obj_SetupUniformGrid(this, xlo, xhi, lo, hi)

Arguments

procedure, public, nopass :: SubDivideBlock => block_obj_SubDivideBlock

private pure subroutine block_obj_SubDivideBlock(coord, Nb, minlo, maxhi, sublo, subhi)

Arguments

procedure, public :: UpdateExtents => block_obj_UpdateExtents

private impure subroutine block_obj_UpdateExtents(this)

Arguments

procedure, public :: UpdateGridGhostCells => block_obj_UpdateGridGhostCells

private impure subroutine block_obj_UpdateGridGhostCells(this)

Arguments

procedure, public :: UpdateMidPoints => block_obj_UpdateMidPoints

private pure subroutine block_obj_UpdateMidPoints(this)

Arguments

procedure, public :: UpdateSpacing => block_obj_UpdateSpacing

private impure subroutine block_obj_UpdateSpacing(this)

Arguments

procedure, public :: Write => block_obj_Write

private impure subroutine block_obj_Write(this, name)

Arguments

procedure, private :: block_obj_Init

private impure subroutine block_obj_Init(this, ngc, parallel)

Arguments

procedure, private :: block_obj_Init2

private impure subroutine block_obj_Init2(this, xlo, xhi, lo, hi, ngc, parallel)

Arguments

Source Code